// --------------------------------------------------------------------------------------------------------------------
// <copyright file="PicknPlaceStatusEnum.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Microsoft.Robotics.Manipulation.PicknPlace
{
    using System;

    /// <summary>
    /// Enumeration of pick and place status
    /// </summary>
    public enum PicknPlaceStatusEnum
    {
        /// <summary>
        /// Task has not stated
        /// </summary>
        NotStarted,

        /// <summary>
        /// Pick task in progress
        /// </summary>
        PickInProgress,

        /// <summary>
        /// Pick request received
        /// </summary>
        PickRequestReceived,

        /// <summary>
        /// Pick task complete
        /// </summary>
        PickComplete,

        /// <summary>
        /// Pick task in progress
        /// </summary>
        PlaceInProgress,

        /// <summary>
        /// Place request received
        /// </summary>
        PlaceRequestReceived,

        /// <summary>
        /// Pick task complete
        /// </summary>
        PlaceComplete,

        /// <summary>
        /// Pick task failed because the visual estimate confidence was too low
        /// </summary>
        PickFailLowConfidence,

        /// <summary>
        /// Pick failed because error on the best visual  visual estimate had too large an error
        /// </summary>
        PickFailLargeError,

        /// <summary>
        /// Pick failed because there was a false positive visual detection
        /// </summary>
        PickFailFalsePositive,

        /// <summary>
        /// Pick failed because there was a false negative visual detection
        /// </summary>
        PickFailFalseNegative,

        /// <summary>
        /// Pick task failed because request is out of range of the arm
        /// </summary>
        PickFailOutOfRange,

        /// <summary>
        /// Place task failed because request is out of range of the arm
        /// </summary>
        PlaceFailOutOfRange
    }
}
